Repository navigation
build(changelog): towncrier news fragments and a draft check - #26
Merged
Merged
Conversation
Release notes went into CHANGELOG.md by hand, so any two pull requests that touch it conflict. The other stackhands repositories take one fragment per change in changelog.d/ and build the section at release with towncrier. towncrier.toml follows theirs, with this changelog's heading and section names. A workflow drafts the changelog on each pull request, with the version from Cargo.toml, and checks that a misnamed fragment fails. CONTRIBUTING asks for a fragment and puts towncrier build in the release steps.
This was referenced Nov 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Release notes go into
CHANGELOG.mdby hand, so any two pull requests that touch it conflict. eb-local, eessi-arch-guard and rfc9162 take one fragment per change inchangelog.d/and build the section at release with towncrier. This does the same here.towncrier.toml: same fragment types as the other repositories (feature,bugfix,doc,removal,misc), with this changelog's## X.Y.Z - dateheading and its Added/Fixed/Documentation/Removed/Changed section names.ignore = []makes a misnamed fragment an error instead of a silent skip.CHANGELOG.mdgets the<!-- towncrier release notes start -->marker above 0.7.4..github/workflows/changelog.ymldrafts the changelog with the version fromCargo.tomland checks that a misnamed fragment fails.towncrier buildin release step 5.towncrier build --draft --version 0.7.4(towncrier 26.9.0) renders the one fragment, and a file namednot-a-fragment.mdfails with "Invalid news fragment name". The workflow YAML andtowncrier.tomlparse. Merge this before theeessi-extend-eb.shfix, which adds a fragment.